<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<title>Proxima Inspector</title>
		<link rel="icon" href="../icons/favicon.ico" />
		<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1">
		<meta property="og:type" content="website">
		<meta name="description" property="og:description" content="Proxima Inspector lets you connect to your live game from a web browser to inspect and edit any property. Just like the Unity editor!">
		<meta name="image" property="og:image" content="../images/proxima-1200x630.png">
		<meta http-equiv="content-security-policy" content="">
		<link href="../_app/immutable/assets/_layout-1f0a7e97.css" rel="stylesheet">
		<link href="../_app/immutable/assets/_layout-6847360b.css" rel="stylesheet">
		
		
		
		
		
		
		
		
		
		
	</head>
	<body>
		<div>


<div class="flex flex-col items-center text-gray-300 w-full min-h-screen bg-[#222]"><div class="flex w-full justify-center items-start bg-[#111] text-white fixed z-20"><div class="flex grow justify-between items-center max-w-[1600px] p-4"><a href="https://www.unityproxima.com"><img src="../images/proxima_logo.png" class="w-[150px]" alt="Logo"></a>
            <button class="lg:hidden"><img class="w-10" src="../icons/menu.png" alt="Menu"></button>
            <div class="flex gap-10 items-center max-lg:hidden">
<a href="https://assetstore.unity.com/publishers/72095?aid=1101lqSYn" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Store</a>
                
<a href="https://app.unityproxima.com/connection" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Demo</a>
                
                <a class="text-xl font-logo" href="../docs.html">Docs</a>
                
<a href="https://discord.gg/VM9cWJ9rjH" class="" referrerpolicy="origin" target="_blank" rel="external"><img width="100px" class="mt-1" src="../icons/discord.png" alt=""></a></div></div>
        </div>

    <div class="pt-[83px] w-full h-full flex flex-col items-center"><div class="w-full flex flex-col items-start min-h-screen max-w-[1600px] px-4"><button class="text-white font-body pt-5 lg:hidden">Go to page &gt;</button>
    <div class="flex w-full min-h-full relative"><div class="h-full fixed border-r-orange-400 bg-[#222] border-r-2 max-lg:hidden"><div class="flex pt-10 flex-col w-[300px] gap-2 border-[#21a6f0] min-h-0 h-full overflow-auto"><b class="text-orange-400">Getting Started</b>
                <a href="../docs.html" class="svelte-yue6wq">Installation</a>
                <a href="../docs/features.html" class="svelte-yue6wq">Feature Overview</a>

                <b class="text-orange-400 mt-5">Connection</b>
                <a href="../docs/supported_platforms.html" class="svelte-yue6wq">Supported Platforms</a>
                <a href="../docs/connect.html" class="svelte-yue6wq">Connect to Your Game</a>
                <a href="../docs/security.html" class="svelte-yue6wq">Security Considerations</a>
                <a href="../docs/all_config.html" class="svelte-yue6wq">All Configuration Options</a>

                <b class="text-orange-400 mt-5">Inspector</b>
                <a href="../docs/inspector.html" class="svelte-yue6wq">GameObject Inspector</a>
                <a href="../docs/buttons.html" class="svelte-yue6wq">Adding Buttons</a>
                <a href="../docs/faq.html" class="svelte-yue6wq">Frequently Asked Questions</a>

                <b class="text-orange-400 mt-5">Logs</b>
                <a href="../docs/logs.html" class="svelte-yue6wq">Log Viewer</a>
                <a href="../docs/viewing_logs_offline.html" class="svelte-yue6wq">Viewing Logs Offline</a>

                <b class="text-orange-400 mt-5">Console</b>
                <a href="../docs/console.html" class="svelte-yue6wq">Console Window</a>
                <a href="../docs/console_built_in.html" class="svelte-yue6wq">Built-in Commands</a>
                <a href="../docs/console_custom.html" class="svelte-yue6wq">Custom Commands</a>

                <b class="text-orange-400 mt-5">Extras</b>
                <a href="../docs/deeplinks.html" class="svelte-yue6wq">Deep Links</a>

                <div class="h-[200px] shrink-0"></div></div></div>

        
        <div class="flex flex-col w-full lg:pl-10 py-10 lg:ml-[300px]"><div class="doc flex flex-col gap-5 svelte-yue6wq"><h1>Built-in Commands</h1>

<h2 class="text-2xl text-orange-400 font-bold">General Commands</h2>
   <div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Get</p>
        <div>(g)</div>
        <div>pattern</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: g</p>
        <p>Get the value of the given property. Can be used with most gameObject properties, component properties, and some statics including: Application, Time, Physics, Screen, AudioSettings, QualitySettings, Input, Physics2D.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>pattern: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; g cube*.transform.position
            <br>Cube1 [123] [1, 2, 3]<br>Cube2 [456] [1, 2, 3]<br>Cube3 [789] [1, 2, 3]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Set</p>
        <div>(s)</div>
        <div>property</div><div>value</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: s</p>
        <p>Set the value of the given property. Can be used with most gameObject properties, component properties, and some statics including: Application, Time, Physics, Screen, AudioSettings, QualitySettings, Input, Physics2D.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>property: String </p><p>value: Object </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; s cube*.transform.position [1, 2, 3]
            <br>Set Cube1 [123] to [1, 2, 3]<br>Set Cube2 [456] to [1, 2, 3]<br>Set Cube3 [789] to [1, 2, 3]</p>
        <p></p>
        <p></p></div></div><h2 class="text-2xl text-orange-400 font-bold">Scene Commands</h2>
   <div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Load</p>
        <div>(ld)</div>
        <div>sceneOrIndex</div><div>(additive)</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: ld</p>
        <p>Load scene by name or build index. If additive is true, the scene is added to the current scene.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>sceneOrIndex: String </p><p>additive: Boolean (Default: false)</p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; ld SampleScene
            <br>Loading scene SampleScene.</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Unload</p>
        <div>(ul)</div>
        <div>sceneOrIndex</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: ul</p>
        <p>Unload scene by name or build index.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>sceneOrIndex: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; ul SampleScene
            <br>Unloading scene SampleScene.</p>
        <p></p>
        <p></p></div></div><h2 class="text-2xl text-orange-400 font-bold">GameObject Commands</h2>
   <div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">AddComponent</p>
        <div>(ac)</div>
        <div>name</div><div>component</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: ac</p>
        <p>Add the component to all gameObjects with the given name.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p><p>component: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; ac cube* Rigidbody
            <br>Added Rigidbody to Cube1 [123]<br>Added Rigidbody to Cube2 [456]<br>Added Rigidbody to Cube3 [789]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Destroy</p>
        <div>(x)</div>
        <div>name</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: x</p>
        <p>Destroy all game objects with the given name.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; x cube*
            <br>Destroyed Cube1 [123]<br>Destroyed Cube2 [456]<br>Destroyed Cube3 [789]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Disable</p>
        <div>(d)</div>
        <div>name</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: d</p>
        <p>Disable the given gameObjects.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; d cube*
            <br>Disabled Cube1 [123]<br>Disabled Cube2 [456]<br>Disabled Cube3 [789]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Enable</p>
        <div>(e)</div>
        <div>name</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: e</p>
        <p>Enable the given gameObjects.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; e cube*
            <br>Enabled Cube1 [123]<br>Enabled Cube2 [456]<br>Enabled Cube3 [789]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">GetComponents</p>
        <div>(comp)</div>
        <div>name</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: comp</p>
        <p>Get the components of the given gameObjects.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; comp cube1
            <br>Cube1 [123] Components:<br>  Transform<br>  MeshFilter<br>  MeshRenderer</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Instantiate</p>
        <div>(i)</div>
        <div>prefabName</div><div>(position)</div><div>(rotation)</div><div>(parent)</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: i</p>
        <p>Instantiate a prefab by name with optional position, rotation, and parent transform.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>prefabName: String </p><p>position: Vector3 (Default: [0,0,0])</p><p>rotation: Quaternion (Default: [0,0,0])</p><p>parent: Transform (Default: null)</p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; i SamplePrefab [0, 1, 0] [0, 45, 0] cube.transform
            <br>Instantiated SamplePrefab(Clone) [123].</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">List</p>
        <div>(ls)</div>
        <div>(name)</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: ls</p>
        <p>List all game objects with the given name.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String (Default: *)</p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; ls cube*
            <br>Cube1 [123]<br>Cube2 [456]<br>Cube3 [789]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">LookAt</p>
        <div>(lk)</div>
        <div>name</div><div>(target)</div><div>(worldUp)</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: lk</p>
        <p>Look at the given target.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p><p>target: Vector3 (Default: [0,0,0])</p><p>worldUp: Vector3 (Default: [0,0,0])</p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; lk cube* player1.transform.position
            <br>Rotated Cube1 [123] to [0, 1, 0]<br>Rotated Cube2 [456] to [0, 1, 0]<br>Rotated Cube3 [789] to [0, 1, 0]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Move</p>
        <div>(mv)</div>
        <div>name</div><div>(position)</div><div>(local)</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: mv</p>
        <p>Move all game objects with the given name to the given position.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p><p>position: Vector3 (Default: [0,0,0])</p><p>local: Boolean (Default: false)</p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; mv cube* [0, 1, 0]
            <br>Moved Cube1 [123] to [0, 1, 0]<br>Moved Cube2 [456] to [0, 1, 0]<br>Moved Cube3 [789] to [0, 1, 0]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">RemoveComponent</p>
        <div>(rc)</div>
        <div>name</div><div>component</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: rc</p>
        <p>Remove the component from all gameObjects with the given name.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p><p>component: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; rc cube* Rigidbody
            <br>Removed Rigidbody from Cube1 [123]<br>Removed Rigidbody from Cube2 [456]<br>Removed Rigidbody from Cube3 [789]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Rotate</p>
        <div>(rt)</div>
        <div>name</div><div>(rotation)</div><div>(local)</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: rt</p>
        <p>Rotate all game objects with the given name to the given rotation.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p><p>rotation: Quaternion (Default: [0,0,0])</p><p>local: Boolean (Default: false)</p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; rt cube* [0, 45, 0]
            <br>Rotated Cube1 [123] to [0, 45, 0]<br>Rotated Cube2 [456] to [0, 45, 0]<br>Rotated Cube3 [789] to [0, 45, 0]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">Scale</p>
        <div>(sc)</div>
        <div>name</div><div>(scale)</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: sc</p>
        <p>Scale all game objects with the given name to the given scale.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p><p>scale: Vector3 (Default: [0,0,0])</p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; sc cube* [2, 2, 2]
            <br>Scaled Cube1 [123] to [2, 2, 2]<br>Scaled Cube2 [456] to [2, 2, 2]<br>Scaled Cube3 [789] to [2, 2, 2]</p>
        <p></p>
        <p></p></div></div><div class="bg-[#1d1d1d] p-3 shadow-lg flex flex-col gap-3 w-full text-left"><div class="flex gap-2 items-center font-mono text-lg"><button><img class="w-[15px]" src="../icons/arrow.png" alt=""></button>
        <p class="">SendMessage</p>
        <div>(sm)</div>
        <div>name</div><div>method</div></div>
    <div class="flex flex-col gap-2 "><p class="font-mono">Alias: sm</p>
        <p>Call a method on all gameObjects with the given name using SendMessage.</p>
        <p>Parameters:</p>
        <div class="ml-5 font-mono"><p>name: String </p><p>method: String </p></div>
        <p class="font-mono bg-[#222] p-3 mt-2 w-full">&gt; sm cube* OnHit
            <br>Sent message OnHit to Cube1 [123]<br>Sent message OnHit to Cube2 [456]<br>Sent message OnHit to Cube3 [789]</p>
        <p></p>
        <p></p></div></div></div></div></div>
</div>
        <div class="h-[200px] flex flex-col"><p class="text-gray-400 m-10">© 2023 Virtual Maker Corporation</p></div></div></div>


		
	</div>
	</body>
</html>
